home *** CD-ROM | disk | FTP | other *** search
/ Java Programmer's Toolkit / Java Programmer's Toolkit.iso / applets / collectn / sortable.jav < prev    next >
Text File  |  1995-10-14  |  1KB  |  49 lines
  1. /*
  2.   File: SortableCollection.java
  3.  
  4.   Originally written by Doug Lea and released into the public domain. 
  5.   Thanks for the assistance and support of Sun Microsystems Labs, Agorics 
  6.   Inc, Loral, and everyone contributing, testing, and using this code.
  7.  
  8.   History:
  9.   Date     Who                What
  10.   24Sep95  dl@cs.oswego.edu   Create from collections.java  working file
  11.  
  12. */
  13.   
  14. package collections;
  15.  
  16. import java.util.Enumeration;
  17. import java.util.NoSuchElementException;
  18.  
  19. /**
  20.  *
  21.  *
  22.  * Sortable is a mixin interface for UpdatableCollections
  23.  * supporting a sort method that accepts
  24.  * a user-supplied Comparator with a compare method that
  25.  * accepts any two Objects and returns -1/0/+1 depending on whether
  26.  * the first is less than, equal to, or greater than the second.
  27.  * <P>
  28.  * After sorting, but in the absence of other mutative operations,
  29.  * Sortable Collections guarantee that enumerations
  30.  * appear in sorted order;  that is if a and b are two elements
  31.  * obtained in succession from nextElement(), that 
  32.  * <PRE>
  33.  * comparator().compare(a, b) <= 0.
  34.  * </PRE>
  35.  * @author Doug Lea
  36.  * @version 0.93
  37.  *
  38.  * <P> For an introduction to this package see <A HREF="index.html"> Overview </A>.
  39. **/
  40.  
  41. public interface SortableCollection extends UpdatableCollection {
  42.  
  43. /**
  44.  * Sort the current elements with respect to cmp.compare.
  45. **/
  46.  
  47.   public void sort(Comparator  cmp);
  48. };
  49.